IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3x/curs_inopts.z/curs_inopts

Text File | 2002-10-03 | 17.3 KB | 191 lines

ccccuuuurrrrssss____iiiinnnnooooppppttttssss((((3333XXXX))))                                                ccccuuuurrrrssss____iiiinnnnooooppppttttssss((((3333XXXX))))



NNNNAAAAMMMMEEEE
     _cccc_uuuu_rrrr_ssss______iiii_nnnn_oooo_pppp_tttt_ssss:  _cccc_bbbb_rrrr_eeee_aaaa_kkkk, _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk, _eeee_cccc_hhhh_oooo, _nnnn_oooo_eeee_cccc_hhhh_oooo, _hhhh_aaaa_llll_ffff_dddd_eeee_llll_aaaa_yyyy, _iiii_nnnn_tttt_rrrr_ffff_llll_uuuu_ssss_hhhh,
     _kkkk_eeee_yyyy_pppp_aaaa_dddd, _mmmm_eeee_tttt_aaaa, _nnnn_oooo_dddd_eeee_llll_aaaa_yyyy, _nnnn_oooo_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt, _rrrr_aaaa_wwww, _nnnn_oooo_rrrr_aaaa_wwww, _nnnn_oooo_qqqq_iiii_ffff_llll_uuuu_ssss_hhhh, _qqqq_iiii_ffff_llll_uuuu_ssss_hhhh,
     _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt, _wwww_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt, _tttt_yyyy_pppp_eeee_aaaa_hhhh_eeee_aaaa_dddd - _cccc_uuuu_rrrr_ssss_eeee_ssss terminal input option control
     routines

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>>

     _iiii_nnnn_tttt _cccc_bbbb_rrrr_eeee_aaaa_kkkk_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _iiii_nnnn_tttt _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _iiii_nnnn_tttt _eeee_cccc_hhhh_oooo_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _iiii_nnnn_tttt _nnnn_oooo_eeee_cccc_hhhh_oooo_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _iiii_nnnn_tttt _hhhh_aaaa_llll_ffff_dddd_eeee_llll_aaaa_yyyy_((((_iiii_nnnn_tttt _tttt_eeee_nnnn_tttt_hhhh_ssss_))))_;;;;
     _iiii_nnnn_tttt _iiii_nnnn_tttt_rrrr_ffff_llll_uuuu_ssss_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _bbbb_oooo_oooo_llll _bbbb_ffff_))))_;;;;
     _iiii_nnnn_tttt _kkkk_eeee_yyyy_pppp_aaaa_dddd_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _bbbb_oooo_oooo_llll _bbbb_ffff_))))_;;;;
     _iiii_nnnn_tttt _mmmm_eeee_tttt_aaaa_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _bbbb_oooo_oooo_llll _bbbb_ffff_))))_;;;;
     _iiii_nnnn_tttt _nnnn_oooo_dddd_eeee_llll_aaaa_yyyy_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _bbbb_oooo_oooo_llll _bbbb_ffff_))))_;;;;
     _iiii_nnnn_tttt _nnnn_oooo_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _bbbb_oooo_oooo_llll _bbbb_ffff_))))_;;;;
     _iiii_nnnn_tttt _rrrr_aaaa_wwww_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _iiii_nnnn_tttt _nnnn_oooo_rrrr_aaaa_wwww_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _vvvv_oooo_iiii_dddd _nnnn_oooo_qqqq_iiii_ffff_llll_uuuu_ssss_hhhh_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _vvvv_oooo_iiii_dddd _qqqq_iiii_ffff_llll_uuuu_ssss_hhhh_((((_vvvv_oooo_iiii_dddd_))))_;;;;
     _vvvv_oooo_iiii_dddd _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt_((((_iiii_nnnn_tttt _dddd_eeee_llll_aaaa_yyyy_))))_;;;;
     _vvvv_oooo_iiii_dddd _wwww_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _iiii_nnnn_tttt _dddd_eeee_llll_aaaa_yyyy_))))_;;;;
     _iiii_nnnn_tttt _tttt_yyyy_pppp_eeee_aaaa_hhhh_eeee_aaaa_dddd_((((_iiii_nnnn_tttt _ffff_dddd_))))_;;;;

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     The _cccc_bbbb_rrrr_eeee_aaaa_kkkk and _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk routines put the terminal into and out of _cccc_bbbb_rrrr_eeee_aaaa_kkkk
     mode, respectively.  In this mode, characters typed by the user are
     immediately available to the program, and erase/kill character-processing
     is not performed.  When out of this mode, the tty driver buffers the
     typed characters until a newline or carriage return is typed.  Interrupt
     and flow control characters are unaffected by this mode.  Initially the
     terminal may or may not be in _cccc_bbbb_rrrr_eeee_aaaa_kkkk mode, as the mode is inherited;
     therefore, a program should call _cccc_bbbb_rrrr_eeee_aaaa_kkkk or _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk explicitly.  Most
     interactive programs using _cccc_uuuu_rrrr_ssss_eeee_ssss set the _cccc_bbbb_rrrr_eeee_aaaa_kkkk mode.

     Note that _cccc_bbbb_rrrr_eeee_aaaa_kkkk overrides _rrrr_aaaa_wwww.  [See curs_getch(3X) for a discussion of
     how these routines interact with _eeee_cccc_hhhh_oooo and _nnnn_oooo_eeee_cccc_hhhh_oooo.]

     The _eeee_cccc_hhhh_oooo and _nnnn_oooo_eeee_cccc_hhhh_oooo routines control whether characters typed by the user
     are echoed by _gggg_eeee_tttt_cccc_hhhh as they are typed.  Echoing by the tty driver is
     always disabled, but initially _gggg_eeee_tttt_cccc_hhhh is in echo mode, so characters typed



                                                                        PPPPaaaaggggeeee 1111






ccccuuuurrrrssss____iiiinnnnooooppppttttssss((((3333XXXX))))                                                ccccuuuurrrrssss____iiiinnnnooooppppttttssss((((3333XXXX))))



     are echoed.  Authors of most interactive programs prefer to do their own
     echoing in a controlled area of the screen, or not to echo at all, so
     they disable echoing by calling _nnnn_oooo_eeee_cccc_hhhh_oooo.  [See curs_getch(3X) for a
     discussion of how these routines interact with _cccc_bbbb_rrrr_eeee_aaaa_kkkk and _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk.]

     The _hhhh_aaaa_llll_ffff_dddd_eeee_llll_aaaa_yyyy routine is used for half-delay mode, which is similar to
     _cccc_bbbb_rrrr_eeee_aaaa_kkkk mode in that characters typed by the user are immediately
     available to the program.  However, after blocking for _t_e_n_t_h_s tenths of
     seconds, ERR is returned if nothing has been typed.  The value of _tttt_eeee_nnnn_tttt_hhhh_ssss
     must be a number between 1 and 255.  Use _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk to leave half-delay
     mode.

     If the _iiii_nnnn_tttt_rrrr_ffff_llll_uuuu_ssss_hhhh option is enabled, (_b_f is _TTTT_RRRR_UUUU_EEEE), when an interrupt key
     is pressed on the keyboard (interrupt, break, quit) all output in the tty
     driver queue will be flushed, giving the effect of faster response to the
     interrupt, but causing _cccc_uuuu_rrrr_ssss_eeee_ssss to have the wrong idea of what is on the
     screen.  Disabling (_b_f is _FFFF_AAAA_LLLL_SSSS_EEEE), the option prevents the flush.  The
     default for the option is inherited from the tty driver settings.  The
     window argument is ignored.

     The _kkkk_eeee_yyyy_pppp_aaaa_dddd option enables the keypad of the user's terminal.  If enabled
     (_b_f is _TTTT_RRRR_UUUU_EEEE), the user can press a function key (such as an arrow key)
     and _wwww_gggg_eeee_tttt_cccc_hhhh returns a single value representing the function key, as in
     _KKKK_EEEE_YYYY______LLLL_EEEE_FFFF_TTTT.  If disabled (_b_f is _FFFF_AAAA_LLLL_SSSS_EEEE), _cccc_uuuu_rrrr_ssss_eeee_ssss does not treat function keys
     specially and the program has to interpret the escape sequences itself.
     If the keypad in the terminal can be turned on (made to transmit) and off
     (made to work locally), turning on this option causes the terminal keypad
     to be turned on when _wwww_gggg_eeee_tttt_cccc_hhhh is called.  The default value for keypad is
     false.

     Initially, whether the terminal returns 7 or 8 significant bits on input
     depends on the control mode of the tty driver [see termio(7)].  To force
     8 bits to be returned, invoke _mmmm_eeee_tttt_aaaa(_w_i_n, _TTTT_RRRR_UUUU_EEEE).  To force 7 bits to be
     returned, invoke _mmmm_eeee_tttt_aaaa(_w_i_n, _FFFF_AAAA_LLLL_SSSS_EEEE).  The window argument, _w_i_n, is always
     ignored.  If the terminfo capabilities _ssss_mmmm_mmmm (meta_on) and _rrrr_mmmm_mmmm (meta_off)
     are  defined for the terminal, _ssss_mmmm_mmmm is sent to the terminal when _mmmm_eeee_tttt_aaaa(_w_i_n,
     _TTTT_RRRR_UUUU_EEEE) is called and _rrrr_mmmm_mmmm is sent when _mmmm_eeee_tttt_aaaa(_w_i_n, _FFFF_AAAA_LLLL_SSSS_EEEE) is called.

     The _nnnn_oooo_dddd_eeee_llll_aaaa_yyyy option causes _gggg_eeee_tttt_cccc_hhhh to be a non-blocking call.  If no input
     is ready, _gggg_eeee_tttt_cccc_hhhh returns _EEEE_RRRR_RRRR.  If disabled (_b_f is _FFFF_AAAA_LLLL_SSSS_EEEE), _gggg_eeee_tttt_cccc_hhhh waits
     until a key is pressed.

     While interpreting an input escape sequence, _wwww_gggg_eeee_tttt_cccc_hhhh sets a timer while
     waiting for the next character.  If _nnnn_oooo_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt_((((_w_i_n, _TTTT_RRRR_UUUU_EEEE) is called, then
     _wwww_gggg_eeee_tttt_cccc_hhhh does not set a timer.  The purpose of the timeout is to
     differentiate between sequences received from a function key and those
     typed by a user.

     With the _rrrr_aaaa_wwww and _nnnn_oooo_rrrr_aaaa_wwww routines, the terminal is placed into or out of
     raw mode.  Raw mode is similar to _cccc_bbbb_rrrr_eeee_aaaa_kkkk mode, in that characters typed
     are immediately passed through to the user program.  The differences are
     that in raw mode, the interrupt, quit, suspend, and flow control



                                                                        PPPPaaaaggggeeee 2222






ccccuuuurrrrssss____iiiinnnnooooppppttttssss((((3333XXXX))))                                                ccccuuuurrrrssss____iiiinnnnooooppppttttssss((((3333XXXX))))



     characters are all passed through uninterpreted, instead of generating a
     signal.  The behavior of the BREAK key depends on other bits in the tty
     driver that are not set by _cccc_uuuu_rrrr_ssss_eeee_ssss.

     When the _nnnn_oooo_qqqq_iiii_ffff_llll_uuuu_ssss_hhhh routine is used, normal flush of input and output
     queues associated with the _IIII_NNNN_TTTT_RRRR, _QQQQ_UUUU_IIII_TTTT and _SSSS_UUUU_SSSS_PPPP characters will not be
     done [see termio(7)].  When _qqqq_iiii_ffff_llll_uuuu_ssss_hhhh is called, the queues will be flushed
     when these control characters are read.

     The _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt and _wwww_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt routines set blocking or non-blocking read for a
     given window.  If _d_e_l_a_y is negative, blocking read is used (_i._e., waits
     indefinitely for input).  If _d_e_l_a_y is zero, then non-blocking read is
     used (_i._e., read returns _EEEE_RRRR_RRRR if no input is waiting).  If _d_e_l_a_y is
     positive, then read blocks for _d_e_l_a_y milliseconds, and returns _EEEE_RRRR_RRRR if
     there is still no input.  Hence, these routines provide the same
     functionality as _nnnn_oooo_dddd_eeee_llll_aaaa_yyyy, plus the additional capability of being able to
     block for only _d_e_l_a_y milliseconds (where _d_e_l_a_y is positive).

     _cccc_uuuu_rrrr_ssss_eeee_ssss does ``line-breakout optimization'' by looking for typeahead
     periodically while updating the screen.  If input is found, and it is
     coming from a tty, the current update is postponed until _rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh or
     _dddd_oooo_uuuu_pppp_dddd_aaaa_tttt_eeee is called again.  This allows faster response to commands typed
     in advance.  Normally, the input FILE pointer passed to _nnnn_eeee_wwww_tttt_eeee_rrrr_mmmm, or _ssss_tttt_dddd_iiii_nnnn
     in the case that _iiii_nnnn_iiii_tttt_ssss_cccc_rrrr was used, will be used to do this typeahead
     checking.  The _tttt_yyyy_pppp_eeee_aaaa_hhhh_eeee_aaaa_dddd routine specifies that the file descriptor _f_d is
     to be used to check for typeahead instead.  If _f_d is -1, then no
     typeahead checking is done.

RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
     All routines that return an integer return _EEEE_RRRR_RRRR upon failure and an
     integer value other than _EEEE_RRRR_RRRR upon successful completion, unless otherwise
     noted in the preceding routine descriptions.

NNNNOOOOTTTTEEEESSSS
     The header file _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> automatically includes the header files
     _<<<<_ssss_tttt_dddd_iiii_oooo_...._hhhh_>>>> and _<<<<_uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh_>>>>.

     Note that _eeee_cccc_hhhh_oooo, _nnnn_oooo_eeee_cccc_hhhh_oooo, _hhhh_aaaa_llll_ffff_dddd_eeee_llll_aaaa_yyyy, _iiii_nnnn_tttt_rrrr_ffff_llll_uuuu_ssss_hhhh, _mmmm_eeee_tttt_aaaa, _nnnn_oooo_dddd_eeee_llll_aaaa_yyyy, _nnnn_oooo_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt,
     _nnnn_oooo_qqqq_iiii_ffff_llll_uuuu_ssss_hhhh, _qqqq_iiii_ffff_llll_uuuu_ssss_hhhh, _tttt_iiii_mmmm_eeee_oooo_uuuu_tttt, and _wwww_tttt_iiii_mmmm_eeee_oooo_uuuu_tttt may be macros.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______gggg_eeee_tttt_cccc_hhhh(3X), _cccc_uuuu_rrrr_ssss______iiii_nnnn_iiii_tttt_ssss_cccc_rrrr(3X), _tttt_eeee_rrrr_mmmm_iiii_oooo(7)













                                                                        PPPPaaaaggggeeee 3333